/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.search.mapper.pojo.extractor.builtin;

import org.hibernate.search.mapper.pojo.extractor.ContainerExtractor;

/**
 * The names of {@link ContainerExtractor container extractors} available in Hibernate Search out of the box.
 */
public class BuiltinContainerExtractors {

	private BuiltinContainerExtractors() {
	}

	/**
	 * The name of an extractor that extracts elements from an object array.
	 */
	public static final String ARRAY = "array";
	/**
	 * The name of an extractor that extracts elements from a {@link java.util.Collection}.
	 */
	public static final String COLLECTION = "collection";
	/**
	 * The name of an extractor that extracts elements from an {@link Iterable}.
	 */
	public static final String ITERABLE = "iterable";
	/**
	 * The name of an extractor that extracts keys from a {@link java.util.Map}.
	 */
	public static final String MAP_KEY = "map-key";
	/**
	 * The name of an extractor that extracts values from a {@link java.util.Map}.
	 */
	public static final String MAP_VALUE = "map-value";
	/**
	 * The name of an extractor that extracts the value from an {@link java.util.OptionalDouble}.
	 */
	public static final String OPTIONAL_DOUBLE = "optional-double";
	/**
	 * The name of an extractor that extracts the value from an {@link java.util.OptionalInt}.
	 */
	public static final String OPTIONAL_INT = "optional-int";
	/**
	 * The name of an extractor that extracts the value from an {@link java.util.OptionalLong}.
	 */
	public static final String OPTIONAL_LONG = "optional-long";
	/**
	 * The name of an extractor that extracts the value from an {@link java.util.Optional}.
	 */
	public static final String OPTIONAL = "optional";

}
